Skip to content

Conversation

@Justin24506
Copy link

Description of the problem

The .github/CONTRIBUTING.md file contained grammatical inconsistencies, typos, and failed standard Markdown linting rules. Specifically, it had inconsistent heading levels (skipping from H1 to H3), causing MD001 errors.

Describe the algorithm of actions that leads to the problem

N/A - This is a documentation refactor, not a logic bug.

Reproducing the problem

# N/A - Documentation fix only.

Description of the Changes

Refactored the CONTRIBUTING.md file to improve clarity, grammar, and formatting:

  • Heading Hierarchy: Fixed MD001 errors by standardizing top-level sections to H2 (##) instead of H3 (###).
  • Grammar & Tone: Updated phrasing for clarity (e.g., changing "Check that..." to "Verify that...") and fixed minor typos (e.g., "an images" -> "images").
  • Formatting: Enforced an 80-character line limit on the updated text for better readability and MD013 compliance.

Code for testing new changes

# N/A - Changes are in .github/CONTRIBUTING.md

Checklist

  • I have read the contribution guidelines.
  • I have tested the changes (verified rendering and formatting).

@Justin24506 Justin24506 deleted the docs/fix-contributing-typos branch January 13, 2026 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant